docs: slim README to 89 lines, hero block above the fold#10
Merged
Conversation
The README had grown to 317 lines across 23+ sections with substantial overlap (three install paths, three Quickstart Examples that repeated the CLI, a 5-step Production Deployment block, a How-It-Works section, a Default Configuration code block that restated CLI options, and a First Run Guide that retold the auth-ladder story already covered elsewhere). Slim version: 89 lines, 9 sections. Top of the file is now a "Try in 60 seconds" hero with the command, the `me` / `me` credentials in a table, and one line about what happens next. Everything below is reference material (CLI options, auth ladder, env-var config, the data-browser philosophy, when to use jspod vs JSS direct, outbound links, license). Removed (content moved to comments inline or simply dropped): - Three install variants (npx is THE install) - Quickstart Examples (redundant with CLI Options) - Production Deployment 5-step block (covered by Configuration + the LAN-exposure warning that jspod itself prints) - Default Configuration code block (CLI Options table covers it) - First Run Guide step-by-step (folded into the hero) - How It Works internals (jspod is small enough to read directly) - Learn More / Contributing scaffolding (replaced by a single Links block + license/credits) No behaviour change; docs-only.
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README went from 317 lines / 23+ sections to 89 lines / 9 sections, with a hero block at the top that gets a new visitor running in 60 seconds.
Before / after
New structure
What was cut
npx jspodis the only install path that matters; global and local are docs-noise for a personal-pod toolWhat stayed
Everything that's load-bearing for a first-time user:
Test plan
Docs-only, no behaviour change. Preview the rendered Markdown on this PR's "Files changed" tab to confirm the hero block is above the fold.